Request meta tests boilerplate #1746

mrmarcosmagalhaes · 2025-07-16T09:18:16Z

Closes #1500

QUALITY CHECKLIST

Changes implemented in code
Complies with our contributing guidelines
Adapted tests
Documentation updated

Related to json-api-dotnet#1500

bkoelman · 2025-07-19T09:09:40Z

Thanks, this looks great!

I've changed the base of this PR, so that status checks run.

codecov · 2025-07-19T09:27:11Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.25%. Comparing base (ae82a95) to head (2cb2e37).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1746   +/-   ##
=======================================
  Coverage   92.24%   92.25%           
=======================================
  Files         437      437           
  Lines       14860    14860           
  Branches     2451     2451           
=======================================
+ Hits        13708    13709    +1     
+ Misses        709      708    -1     
  Partials      443      443

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

bkoelman · 2025-12-03T01:54:13Z

@mrmarcosmagalhaes, do you still want to complete the work on this PR? If not, please let me know, so I can pick up from here.

mrmarcosmagalhaes · 2025-12-08T07:22:38Z

Good morning I want to finalize this pull request. Sorry for the late reply. I had another child and i didn't have so much time. Until to next weekend i will implement your suggestions 👌 Regards, Marcos Magalhães A quarta, 3/12/2025, 01:54, Bart Koelman ***@***.***> escreveu:

…

*bkoelman* left a comment (json-api-dotnet/JsonApiDotNetCore#1746) <#1746 (comment)> @mrmarcosmagalhaes <https://github.com/mrmarcosmagalhaes>, do you still want to complete the work on this PR? If not, please let me know, so I can pick up from here. — Reply to this email directly, view it on GitHub <#1746 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEOSMSAGDVHA64QHCUHPVWL37Y7FXAVCNFSM6AAAAACBUJV36GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTMMBUGY4TKNJTHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

bkoelman · 2025-12-09T09:03:34Z

Congratulations! Looking forward to your contribution.

mrmarcosmagalhaes · 2025-12-20T18:05:56Z

@bkoelman Completed and consolidated RequestMetaTests.
All resource, relationship, and atomic operations now have a single integration test per endpoint, covering all valid meta locations.
Added full coverage for atomic relationship operations (to-one and to-many), fully aligned with the JSON:API spec.
Sorry for the late push but my life right now is not easy.

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

…rmarcosmagalhaes/JsonApiDotNetCore into request-meta-tests-boilerplate

bkoelman · 2026-01-12T22:48:38Z

@mrmarcosmagalhaes Can you take a look at the build errors?

mrmarcosmagalhaes · 2026-01-13T21:51:39Z

Yes, tomorrow i will check. A segunda, 12/01/2026, 22:49, Bart Koelman ***@***.***> escreveu:

…

*bkoelman* left a comment (json-api-dotnet/JsonApiDotNetCore#1746) <#1746 (comment)> @mrmarcosmagalhaes <https://github.com/mrmarcosmagalhaes> Can you take a look at the build errors? — Reply to this email directly, view it on GitHub <#1746 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEOSMSFX5E7223H5O3YDGUT4GQQF3AVCNFSM6AAAAACBUJV36GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTONBQHA3DGNBTHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

…rmarcosmagalhaes/JsonApiDotNetCore into request-meta-tests-boilerplate

This reverts commit 5ee4d79.

bkoelman

Thanks for addressing all the feedback. Minus the comments posted here, I think RequestMetaTests is good to go. I've added a comment requesting to sync up the operations tests, which I'll take a closer look at next time.

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/OperationsRequestMetaTests.cs

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/MetaFakers.cs

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/OperationsRequestMetaTests.cs

bkoelman

I've left some more feedback. The tests for operations are not quite in sync yet.

bkoelman · 2026-01-18T22:27:55Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

+    }
+
+    [Fact]
+    public async Task Accepts_meta_in_remove_from_ToOne_relationship_request()


Suggested change

public async Task Accepts_meta_in_remove_from_ToOne_relationship_request()

public async Task Accepts_meta_in_remove_from_ToMany_relationship_request()

I don't understand why this was changed from to-many to to-one.

The test name does not match the implementation. I’ve already reverted the test name and refactor de code.

bkoelman · 2026-01-18T22:29:07Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

+        await _testContext.RunOnDatabaseAsync(async dbContext =>
+        {
+            dbContext.ProductFamilies.Add(existingFamily);
+            existingTicket.ProductFamily = existingFamily;


This should be moved to before the RunOnDatabaseAsync block, like this:

ProductFamily existingFamily = _fakers.ProductFamily.GenerateOne(); SupportTicket existingTicket = _fakers.SupportTicket.GenerateOne(); existingTicket.ProductFamily = existingFamily;

bkoelman · 2026-01-18T22:33:27Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

+
+        store.Document.Meta.Should().BeEquivalentToJson(documentMeta);
+
+        store.Document.Data.Should().NotBeNull();


Document.Data is a struct, so it can never be null. Therefore, this line is redundant.

bkoelman · 2026-01-18T22:33:46Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

+
+        store.Document.Meta.Should().BeEquivalentToJson(documentMeta);
+
+        store.Document.Data.Should().NotBeNull();


Document.Data is a struct, so it can never be null. Therefore, this line is redundant.

bkoelman · 2026-01-18T22:37:25Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

+
+        store.Document.Should().NotBeNull();
+
+        store.Document.Data.SingleValue.Should().BeNull();


This endpoint updates a to-many relationship (data is an array). I don't think it makes sense to assert that data is not an object. So this assertion can be removed.

bkoelman · 2026-01-18T23:05:44Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

+    }
+
+    [Fact]
+    public async Task Accepts_meta_in_add_ToMany_relationship_request()


Suggested change

public async Task Accepts_meta_in_add_ToMany_relationship_request()

public async Task Accepts_meta_in_add_to_ToMany_relationship_request()

bkoelman · 2026-01-18T23:09:04Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/OperationsRequestMetaTests.cs

+    }
+
+    [Fact]
+    public async Task Accepts_meta_in_add_resource_request_with_ToMany_relationship_operation()


The naming pattern is not simply to add "_operation" to all existing names.

This is an operation that updates a resource, along with its to-many relationship. Therefore, the name should be: "Accepts_meta_in_add_resource_operation_with_ToMany_relationship". Please verify the other names within OperationsRequestMetaTests.cs for correctness.

bkoelman · 2026-01-18T23:13:54Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs

+        SupportTicket existingTicket1 = _fakers.SupportTicket.GenerateOne();
+        SupportTicket existingTicket2 = _fakers.SupportTicket.GenerateOne();
+        ProductFamily existingFamily = _fakers.ProductFamily.GenerateOne();


existingFamily should come first (as it does in the operations equivalent), because that's where the scenario starts (see the request URL).

Applies to multiple tests.

bkoelman · 2026-01-18T23:15:50Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/OperationsRequestMetaTests.cs

+    }
+
+    [Fact]
+    public async Task Accepts_meta_in_remove_from_ToOne_relationship_operation()


This test is about to-many.

bkoelman · 2026-01-18T23:18:25Z

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/OperationsRequestMetaTests.cs

+    }
+
+    [Fact]
+    public async Task Accepts_meta_in_atomic_remove_resource_operation()


Suggested change

public async Task Accepts_meta_in_atomic_remove_resource_operation()

public async Task Accepts_meta_in_remove_resource_operation()

…rmarcosmagalhaes/JsonApiDotNetCore into request-meta-tests-boilerplate

bkoelman and others added 14 commits March 3, 2025 22:30

Basic boilerplate for writing meta tests

cd9fa50

Related to json-api-dotnet#1500

test: accepts top level meta in POST resource request

f0208a0

test: accepts top level meta in PATCH relationship request

11a6580

test: accepts top level meta in POST relationship request

d34319e

test: accepts top level meta in DELETE relationship request

b68dd8f

test: accepts top level meta in atomic UPDATE resource request

1498a0b

test: accepts top level meta in atomic ADD resource request

eeebcd9

test: accepts top level meta in atomic REMOVE resource request

c33e9db

test: accepts meta in data of POST resource request

6bf58d3

test: accepts meta in relationship of POST resource request

7c768eb

test: accepts meta in data of atomic ADD resource request

b083bd2

test: accepts meta in relationship of atomic UPDATE resource request

b05bb8f

refactor after execute inspect code script

fd5d2bd

remove code style warnings

6238c91

bkoelman changed the base branch from request-meta-tests-boilerplate to master July 19, 2025 09:08

Merge branch 'master' into request-meta-tests-boilerplate

f8d646c

Rune code cleanup

062c0bc

Fix inspections

3605490

bkoelman reviewed Jul 19, 2025

View reviewed changes

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs Show resolved Hide resolved

bkoelman reviewed Jul 19, 2025

View reviewed changes

test/JsonApiDotNetCoreTests/IntegrationTests/Meta/RequestMetaTests.cs Show resolved Hide resolved

mrmarcosmagalhaes added 2 commits December 11, 2025 22:44

Merge branch 'master' into request-meta-tests-boilerplate

8dc82d3

Align request meta integration tests with JSON:API requirements

e49e5dd

mrmarcosmagalhaes closed this Dec 20, 2025

mrmarcosmagalhaes reopened this Dec 20, 2025

bkoelman reviewed Dec 27, 2025

View reviewed changes

mrmarcosmagalhaes added 7 commits December 28, 2025 18:46

Add relationship endpoints tests

b4823d7

Isolate atomic operations request tests

cacd9c6

Add missing meta data coverage

607ca90

Resolve code cleanup warnings

925989f

Merge branch 'master' into request-meta-tests-boilerplate

96174ad

Resolve remaining code cleanup warnings

5c540b5

Merge branch 'request-meta-tests-boilerplate' of https://github.com/m…

bcc248b

…rmarcosmagalhaes/JsonApiDotNetCore into request-meta-tests-boilerplate

mrmarcosmagalhaes added 10 commits January 14, 2026 22:08

Merge branch 'master' into request-meta-tests-boilerplate

0e069ff

Fix build

63754fd

Merge branch 'request-meta-tests-boilerplate' of https://github.com/m…

bb6ba33

…rmarcosmagalhaes/JsonApiDotNetCore into request-meta-tests-boilerplate

fix warnings

b5e99a6

Add test to check meta in operation level

5ee4d79

Revert "Add test to check meta in operation level"

5b44ea4

This reverts commit 5ee4d79.

Add test to check meta in operation level

0c6328f

Fix compilation error

8c306ef

fix warnings

35e6533

fix cleanup-code task

fdac076

mrmarcosmagalhaes requested a review from bkoelman January 14, 2026 23:34

bkoelman requested changes Jan 15, 2026

View reviewed changes

mrmarcosmagalhaes added 3 commits January 17, 2026 16:28

Pushed updates addressing review comments.

539382b

Pushed updates addressing missing review comments.

689405b

Fix failed code inspection

a133a32

mrmarcosmagalhaes requested a review from bkoelman January 18, 2026 19:08

bkoelman requested changes Jan 18, 2026

View reviewed changes

mrmarcosmagalhaes added 3 commits January 19, 2026 22:59

Merge branch 'master' into request-meta-tests-boilerplate

e430672

Pushed updates addressing review comments.

b072dd5

Merge branch 'request-meta-tests-boilerplate' of https://github.com/m…

2cb2e37

…rmarcosmagalhaes/JsonApiDotNetCore into request-meta-tests-boilerplate

	public async Task Accepts_meta_in_remove_from_ToOne_relationship_request()
	public async Task Accepts_meta_in_remove_from_ToMany_relationship_request()


		store.Document.Meta.Should().BeEquivalentToJson(documentMeta);

		store.Document.Data.Should().NotBeNull();


		store.Document.Should().NotBeNull();

		store.Document.Data.SingleValue.Should().BeNull();

	public async Task Accepts_meta_in_add_ToMany_relationship_request()
	public async Task Accepts_meta_in_add_to_ToMany_relationship_request()

	public async Task Accepts_meta_in_atomic_remove_resource_operation()
	public async Task Accepts_meta_in_remove_resource_operation()

Uh oh!

Request meta tests boilerplate #1746

Are you sure you want to change the base?

Request meta tests boilerplate #1746

Conversation

mrmarcosmagalhaes commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QUALITY CHECKLIST

Uh oh!

bkoelman commented Jul 19, 2025

Uh oh!

codecov bot commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

bkoelman commented Dec 3, 2025

Uh oh!

mrmarcosmagalhaes commented Dec 8, 2025 via email

Uh oh!

bkoelman commented Dec 9, 2025

Uh oh!

mrmarcosmagalhaes commented Dec 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bkoelman commented Jan 12, 2026

Uh oh!

mrmarcosmagalhaes commented Jan 13, 2026 via email

Uh oh!

bkoelman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bkoelman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

mrmarcosmagalhaes commented Jul 16, 2025 •

edited

Loading

codecov bot commented Jul 19, 2025 •

edited

Loading